#ifndef HELP_HPP_
#define HELP_HPP_
/*******************************************************************************
 ** Name: help.hpp                                                       **
 ** Description:                                                              **
 **                                                                           **
 ** Open Source Initiative (OSI) Approved License                             **
 **                                                                           **
 **  Copyright (c) 2009-2010 Barry "Gian" James  <bjames@munixos.net>         **
 **  All rights reserved.                                                     **
 **                                                                           **
 **  Redistribution and use in source and binary forms, with or without       **
 **  modification, are permitted provided that the following conditions are   **
 **  met:                                                                     **
 **                                                                           **
 **  * Redistributions of source code must retain the above copyright notice, **
 **    this list of conditions and the following disclaimer.                  **
 **  * Redistributions in binary form must reproduce the above copyright      **
 **    notice, this list of conditions and the following disclaimer in the    **
 **    documentation and/or other materials provided with the distribution.   **
 **                                                                           **
 **  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS      **
 ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED **
 ** TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           **
 ** PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT        **
 ** HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,    **
 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED  **
 ** TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR    **
 ** PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    **
 ** LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      **
 ** NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        **
 ** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              **
 **                                                                           **
 ******************************************************************************/
// Created on April 4, 2010, 10:03 AM
// Modified $Date$ by $Author$
#define help_hpp_ID   "$Id$"

#include <string>
#include <bitset>
#include <map>
#include <fstream>
#include <iostream>
#include <cmd.hpp>

#define DEFAULT_HELPFILE_INDEX_SEP	':'

struct HelpFileValue
{
	std::string		name;
	std::string		syntax;
	CmdType			type;
	CmdCategory		category;
	std::string		desc;
	std::string		example;
	std::bitset<16>	flags;
};

class HelpFile
{
public:
	HelpFile(const std::string & n);

	// Init() must be first thing called in this class
	bool	Init();
	int		Parse();

	void	Print(int, const std::string & t);
private:
	std::string	fl;
	std::ifstream	helpFile;
	std::map<std::string,HelpFileValue> terms;
};

// If we deem the help file contents are too much to keep in memory, then
// we'll just compile an index
class HelpFileIndex
{
public:
	HelpFileIndex() { sep = DEFAULT_HELPFILE_INDEX_SEP; }

	int		Compile();

private:
	std::ifstream helpFile;
	std::map<std::string,int>	index;
	static char sep;
};


#endif /* HELP_HPP_ */
